Rule: directory-package-mismatch
#1024
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| ([via Regal](https://docs.styra.com/regal/language-server#code-completions)) suggesting the package path | ||
| `authorization.rbac.roles`. | ||
|
|
||
|  |
There was a problem hiding this comment.
I think this will need to similar to this: https://github.com/StyraInc/docs/blob/main/docs/regal/language-server.md?plain=1#L26-L28
There was a problem hiding this comment.
Ugh :/ But thanks! Fixed in last push.
charlieegan3
approved these changes
Aug 29, 2024
Time to ruffle some feathers! Or move to the `custom` category, I haven't decided yet 😆 Either way, while this rule can certainly feel disruptive, larger policy projects *should* have a uniform structure. Some notes on the implementation: - Does not complain if a single file is provided, i.e. when there is no path except for the file. So `regal lint p.rego` will not result in a violation. - Allows `_test` packages to either reside in the same directory as the package they test (this is the default) or to be kept in a separate directory matching the package exactly (optional). Other than the rule implementation itself, this naturally required that we we restructured all of our own directories to follow this convention. I wasn't too sure about it at first, but the result definitely seems both clean and correct, so I think we're right about this. Also helped correct a few typos in names! Fixes #1007 Signed-off-by: Anders Eknert <[email protected]>
anderseknert
force-pushed
the
directory-structure
branch
from
f11a556
to
5cc9f70
Compare
srenatus
pushed a commit
to srenatus/regal
that referenced
this pull request
Oct 1, 2024
Time to ruffle some feathers! Or move to the `custom` category, I haven't decided yet 😆 Either way, while this rule can certainly feel disruptive, larger policy projects *should* have a uniform structure. Some notes on the implementation: - Does not complain if a single file is provided, i.e. when there is no path except for the file. So `regal lint p.rego` will not result in a violation. - Allows `_test` packages to either reside in the same directory as the package they test (this is the default) or to be kept in a separate directory matching the package exactly (optional). Other than the rule implementation itself, this naturally required that we we restructured all of our own directories to follow this convention. I wasn't too sure about it at first, but the result definitely seems both clean and correct, so I think we're right about this. Also helped correct a few typos in names! Fixes StyraInc#1007 Signed-off-by: Anders Eknert <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Time to ruffle some feathers! Or move to the
customcategory, I haven't decided yet 😆 Either way, while this rule can certainly feel disruptive, larger policy projects should have a uniform structure.Some notes on the implementation:
regal lint p.regowill not result in a violation._testpackages to either reside in the same directory as the package they test (this is the default) or to be kept in a separate directory matching the package exactly (optional).Other than the rule implementation itself, this naturally required that we we restructured all of our own directories to follow this convention. I wasn't too sure about it at first, but the result definitely seems both clean and correct, so I think we're right about this. Also helped correct a few typos in names!
Fixes #1007